<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class RetornoBase</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class RetornoBase</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
							<a href="#sec-descendents">Descendents</a>
			|											<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Classe base para leitura de arquivos de retorno de cobranças dos bancos brasileiros.<br /></p>
	<ul class="tags">
				<li><span class="field">author:</span> Manoel Campos da Silva Filho. http://manoelcampos.com/contato</li>
				<li><span class="field">version:</span> 0.2</li>
				<li><span class="field">copyright:</span> GPLv2</li>
				<li><span class="field">abstract:</span> </li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_RetornoBase.php.html">/RetornoBase.php</a> (line <span class="field">9</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>

	<a name="sec-descendents"></a>
	<div class="info-box">
		<div class="info-box-title">Direct descendents</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
			<span class="disabled">Descendents</span>
			|												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
								|															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<table cellpadding="2" cellspacing="0" class="class-table">
				<tr>
					<th class="class-table-header">Class</th>
					<th class="class-table-header">Description</th>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../ArquivoRetornoTitulosBancarios/RetornoCNAB240.html">RetornoCNAB240</a></td>
					<td>
											Classe para leitura de arquivos de retorno de cobranças no padrão CNAB240.<br />
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../ArquivoRetornoTitulosBancarios/RetornoCNAB400.html">RetornoCNAB400</a></td>
					<td>
											Classe para leitura de arquivos de retorno de cobranças no padrão CNAB400.<br />  Layout Padrão CNAB/Febraban 400 posições<br />.
										</td>
				</tr>
							</table>
		</div>
	</div>


	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$aoProcessarLinha" title="details" class="var-name">$aoProcessarLinha</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$nomeArquivo" title="details" class="var-name">$nomeArquivo</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																				
												<div class="method-definition">
											<span class="method-result">RetornoBase</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											([<span class="var-type">string</span>&nbsp;<span class="var-name">$nomeArquivo</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$aoProcessarLinhaFunctionName</span> = <span class="var-default">&quot;&quot;</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#formataData" title="details" class="method-name">formataData</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$data</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">float</span>
										<a href="#formataNumero" title="details" class="method-name">formataNumero</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$valor</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$numCasasDecimais</span> = <span class="var-default">2</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getNomeArquivo" title="details" class="method-name">getNomeArquivo</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">array</span>
										<a href="#processarLinha" title="details" class="method-name">processarLinha</a>
											(<span class="var-type">int</span>&nbsp;<span class="var-name">$numLn</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$linha</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setAoProcessarLinha" title="details" class="method-name">setAoProcessarLinha</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$handlerFunctionName</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setNomeArquivo" title="details" class="method-name">setNomeArquivo</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$nomeArquivo</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#triggerAoProcessarLinha" title="details" class="method-name">triggerAoProcessarLinha</a>
											(<span class="var-type">int</span>&nbsp;<span class="var-name">$numLn</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$vlinha</span>)
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$aoProcessarLinha" id="$aoProcessarLinha"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$aoProcessarLinha</span>
			 = <span class="var-default">&quot;&quot;</span>			(line <span class="line-number">16</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">property:</span> string $aoProcessarLinha: Armazena o nome da função handler  que será chamada após o processamento de cada linha do arquivo, com  isto, definindo um evento aoProcessarLinha.</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$nomeArquivo" id="$nomeArquivo"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$nomeArquivo</span>
			 = <span class="var-default"> &quot;retorno.ret&quot;</span>			(line <span class="line-number">12</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">property:</span> string $nomeArquivo: Nome do arquivo de texto a ser lido</li>
				<li><span class="field">access:</span> private</li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">24</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Construtor da classe.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">RetornoBase</span>
		<span class="method-name">
			__construct
		</span>
					([<span class="var-type">string</span>&nbsp;<span class="var-name">$nomeArquivo</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$aoProcessarLinhaFunctionName</span> = <span class="var-default">&quot;&quot;</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$nomeArquivo</span><span class="var-description">: Nome do arquivo de retorno do banco.</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$aoProcessarLinhaFunctionName</span><span class="var-description">: Nome da função handler a ser associada  ao evento aoProcessarLinha. Se for informado um valor ao parâmetro, a função, indicada por ele,  será executada após cada linha ser processada no arquivo de retorno.</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../ArquivoRetornoTitulosBancarios/RetornoCNAB240.html#method__construct">RetornoCNAB240::__construct()</a>
							</li>
					<li>
				<a href="../ArquivoRetornoTitulosBancarios/RetornoCNAB400.html#method__construct">RetornoCNAB400::__construct()</a>
							</li>
				</ul>
	</div>
<a name="methodformataData" id="formataData"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">formataData</span> (line <span class="line-number">101</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Formata uma string, contendo uma data sem o separador, no formato DDMMAA ou DDMMAAAA,  para o formato DD/MM/AAAA.</p>
	<ul class="tags">
				<li><span class="field">return:</span> Retorna a data non formato DD/MM/AAAA.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			formataData
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$data</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$data</span><span class="var-description">: String contendo a data no formato DDMMAA ou DDMMAAAA.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodformataNumero" id="formataNumero"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">formataNumero</span> (line <span class="line-number">85</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Formata uma string, contendo um valor real (float) sem o separador de decimais,  para a sua correta representação real.</p>
	<ul class="tags">
				<li><span class="field">return:</span> Retorna o número representado em $valor, no seu formato float,  contendo o separador de decimais.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">float</span>
		<span class="method-name">
			formataNumero
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$valor</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$numCasasDecimais</span> = <span class="var-default">2</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$valor</span><span class="var-description">: String contendo o valor na representação  usada nos arquivos de retorno do banco, sem o separador de decimais.</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$numCasasDecimais</span><span class="var-description">: Total de casas decimais do número  representado em $valor.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetNomeArquivo" id="getNomeArquivo"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getNomeArquivo</span> (line <span class="line-number">33</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Getter para o atributo @see nomeArquivo</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getNomeArquivo
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodprocessarLinha" id="processarLinha"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">processarLinha</span> (line <span class="line-number">41</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Processa uma linha do arquivo de retorno. O método é abstrato e deve ser implementado nas sub-classes.</p>
	<ul class="tags">
				<li><span class="field">return:</span> Retorna um vetor associativo contendo os valores da linha processada.</li>
				<li><span class="field">abstract:</span> </li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			processarLinha
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$numLn</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$linha</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$numLn</span><span class="var-description">: Número da linha a ser processada</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$linha</span><span class="var-description">: String contendo a linha a ser processada</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../ArquivoRetornoTitulosBancarios/RetornoCNAB240.html#methodprocessarLinha">RetornoCNAB240::processarLinha()</a>
								: Processa uma linha_arquivo_retorno.
							</li>
					<li>
				<a href="../ArquivoRetornoTitulosBancarios/RetornoCNAB400.html#methodprocessarLinha">RetornoCNAB400::processarLinha()</a>
								: Processa uma linha do arquivo de retorno.
							</li>
				</ul>
	</div>
<a name="methodsetAoProcessarLinha" id="setAoProcessarLinha"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setAoProcessarLinha</span> (line <span class="line-number">53</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Atribui uma função ao evento aoProcessarLinha.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setAoProcessarLinha
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$handlerFunctionName</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$handlerFunctionName</span><span class="var-description">: String contendo o nome da função handler,  definida pelo usuário fora da classe, que será executada quando o evento aoProcessarLinha for disparado.  Esta função deve ter a assinatura funcao($numLn, $vlinha), onde  $numLn recebe o número da linha processada e $vlinha recebe um vetor associativo  contendos os valores da linha.  Nela o usuário pode fazer o que desejar com os parâmetro recebidos ($numLn e $vlinha),  como setar um campo em uma tabela do banco de dados, para indicar <ul><li>pagamento de um boleto de um determinado cliente.</li></ul></span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetNomeArquivo" id="setNomeArquivo"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setNomeArquivo</span> (line <span class="line-number">31</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Setter para o atributo @see nomeArquivo</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setNomeArquivo
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$nomeArquivo</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$nomeArquivo</span>			</li>
				</ul>
		
			
	</div>
<a name="methodtriggerAoProcessarLinha" id="triggerAoProcessarLinha"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">triggerAoProcessarLinha</span> (line <span class="line-number">65</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Se existe uma função handler associadao ao evento aoProcessarLinha,  executa a mesma, disparando o evento.</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../ArquivoRetornoTitulosBancarios/RetornoBase.html#methodsetAoProcessarLinha">RetornoBase::setAoProcessarLinha()</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			triggerAoProcessarLinha
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$numLn</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$vlinha</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$numLn</span><span class="var-description">: Número da linha processada.</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$vlinha</span><span class="var-description">: Vetor contendo a linha processada, contendo os valores da armazenados  nas colunas deste vetor. Nesta função o usuário pode fazer o que desejar,  como setar um campo em uma tabela do banco de dados, para indicar <ul><li>pagamento de um boleto de um determinado cliente.</li></ul></span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Wed, 20 Apr 2011 09:10:48 -0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>